vcStatisticsChart

vcStatisticsChart is an object type for plotting and graphing the data of reported items in a chart.

See in: Overview

Module: vcCore

Parent: vcObject

Children -

Referenced by: vcStatisticsSeries.ParentChart, vcStatisticsTab.SelectedChart, vcStatisticsTab.createChart()

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
AllSources	list	R	Gets all sources of reported items, including their components. See more A reported item is a vcProperty object associated with a component. For example, a reported item could be a component property or a property of a component behavior. A vcVector object is used to define the display color of reported item in chart. Each element in the list is a list that contains these elements : vcProperty property, String expression, vcComponent component, vcVector color, Double thickness);
ChartType	vcChartType	RW	Gets or sets the chart type.
DataRows	list	R	Gets the data collected during a simulation from reported items. See more Each element in the list is a list that contains these elements : Double simulationTime, Double value1, ... Double valueN
DataType	vcChartDataType	RW	Gets or sets the data type of the chart.
FieldCountPerProperty	Integer	R	Gets the field count of items reported by chart.
LegendVisibility	Boolean	RW	Gets or sets the value defining if chart legend is visible.
Name	String	RW	Gets or sets the title of the chart.
Position	list	RW	Gets or sets the position of the chart in tab grid. See more The list contains these elements : String name, Integer column, Integer row, Integer columnSpan, Integer rowSpan. Exceptions: ValueError: When the given list contains an invalid value.
RecordAccumulatedValues	Boolean	RW	Gets the value defining if collection of data reported by chart is enabled.
SamplingInterval	Real	RW	Gets the value defining how often (in seconds) the chart updates to show recorded data during a simulation. If -1, the chart uses the sampling interval of its dashboard.
Series	list	R	Gets a list of data series used by chart to report items.
TileType	vcChartTileType	R	Gets the location type of chart, thereby indicating whether the tile is an empty or filled with a chart. See more Generally, you would use TileType to parse through several charts in a dashboard to collect data from charts that report items. For example, you could ignore or skip empty tiles.
TitleVisibility	Boolean	RW	Gets or sets the value defining if chart title is visible.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
clearData	None	None	Removes all data reported by chart, thereby emptying DataRows.
clearSeries	None	None	Resets all data series in chart, thereby emptying AllSources.
createSeries	vcStatisticsSeries	None	Creates and adds a new data series to the chart. Returns: vcStatisticsSeries: The created statistics series.
delete	None	None	Deletes this chart.
update	None	None	Refreshes the chart.